<?php
/**
 * Slipstream :: Highly adaptive dependency injection framework
 * Copyright 2010-2011 Ian Unruh (Xerof3ar)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Slipstream\Configuration\Context;
use Slipstream\Configuration\ContextInterface;

/**
 * 
 * 
 * @author Ian Unruh (Xerof3ar) <ianunruh@gmail.com>
 * @since Class avaliable since release 1.0
 */
interface WalkerInterface
{
	/**
	 * Returns the current context the walker is on
	 * @return ContextInterface
	 */
	public function getContext();
	
	/**
	 * Walks to the next context
	 * @return bool Returns true if there is a context to walk to
	 */
	public function next();
	
	/**
	 * Resets the walker to its initial position (the root context)
	 * @return void
	 */
	public function reset();
	
	/**
	 * Sets the target context to walk to
	 * 
	 * @param ContextInterface $targetContext
	 * @return void
	 */
	public function setTargetContext(ContextInterface $targetContext);
}